Before Upgrading

Perform these tasks before upgrading:

  1. Perform a full backup of all OneStream databases.

  2. Download Client Software and Self-Hosted Server (for on-premises installations) from Solution Exchange for the appropriate setup files:

    1. Log in to Solution Exchange, and select Platform to get the latest version of OneStream.

    2. Download Client Software and Self-Hosted Server (for on-premises installations) for the appropriate setup files for the server installation.

  3. Confirm the location of the OneStream configuration files:
    1. On a OneStream server, select Start > Programs > OneStream Software > OneStream Server Configuration Utility.
    2. Right-click the utility and select Run as Administrator.
    3. Select File > Open ASP.NET Configuration File and open the appsettings.json file from the following locations.

      • Web servers: C:\Program Files\OneStream Software\OneStream
        WebRoot\OneStreamWeb

      • Application servers: C:\Program Files\OneStream Software\
        OneStreamAppRoot\OneStreamApp

    4. The file opens and displays the path to the XFAppServerConfig.xml and XFWebServerConfig.xml configuration files.

    5. Take note of the path to the configuration files. You will specify this location during the upgrade.

    NOTE: This path is commonly set to C:\OneStreamShare\Config

  4. Make a copy of the configuration files contained in this folder, and save them to a backup folder of your choice.

  5. Close the file without saving and exit the utility.

  6. Obtain the OneStream service account in Internet Information Services Manager. Note the Windows account and password because you will enter them in IIS after the upgrade.

    NOTE: The service account must be an Admin ID or in the IIS_IUSRS Group, Performance Log User, and Performance Monitor Users group. The ID is required for queuing and CPU monitoring.

    1. On each OneStream server, select Start > Control Panel > Administrative Tools > Internet Information Services (IIS) Manager.

    2. Expand the server and select Application Pools. This displays application pools to the right. The OneStreamAppAppPool and OneStreamWebAppPool service accounts display in the Identity column.

  7. Confirm the IIS OneStream App Server Site and OneStream Web Server Site Binding Information. If they are not kept as default and the type was http or https, the port number (and certificate if used for https) can be restored. This information will not be available if OneStream is uninstalled.

  8. Confirm that the OneStream Database Configuration Utility is installed on each OneStream application server. Click Start > Programs > OneStream Software.

  9. Confirm that OneStream is installed on each OneStream application server. Click Start > Programs > OneStream Software.

  10. Install the following:

  11. On-premises customers must enable the Trust Server Certificate for the OneStream Database Server using the OneStream Server Configuration Utility:

    1. Select File > Open Application Server Configuration File.

    2. Navigate to C:\OneStreamShare\Config or the location of configuration files from step 3e.

    3. Open the App Server Config file.

    4. Locate Database Server Connections.

    5. Click to open the Database Server Connections.

    6. At the end of the Connection String, add TrustServerCertificate=True.

    7. Click the OK button.

    All Application Databases

    From the OneStream Database Configuration Utility:

    1. Right-click on a database, click Edit the Database Connection.

    2. Select Advanced.

    3. Set Trust Server Certificate to True, then click the OK button.

    4. Select Test Connection to ensure a successful connection.

    NOTE: Alternatively, set the TrustServerCertificate to True directly in the XML.

    Repeat these steps for all Application Databases.